<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.configuration;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.File;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.IOException;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.io.InputStream;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.net.URL;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Collection;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.LinkedList;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.util.Map;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.configuration.plist.PropertyListConfiguration;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.commons.configuration.plist.XMLPropertyListConfiguration;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.commons.digester.AbstractObjectCreationFactory;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.commons.digester.CallMethodRule;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.commons.digester.Digester;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.commons.digester.ObjectCreationFactory;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.commons.digester.Substitutor;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.commons.digester.substitution.MultiVariableExpander;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.commons.digester.substitution.VariableSubstitutor;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.commons.digester.xmlrules.DigesterLoader;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.commons.logging.Log;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.40"></a>
<FONT color="green">041</FONT>    import org.xml.sax.Attributes;<a name="line.41"></a>
<FONT color="green">042</FONT>    import org.xml.sax.SAXException;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>    /**<a name="line.44"></a>
<FONT color="green">045</FONT>     * &lt;p&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * Factory class to create a CompositeConfiguration from a .xml file using<a name="line.46"></a>
<FONT color="green">047</FONT>     * Digester.  By default it can handle the Configurations from commons-<a name="line.47"></a>
<FONT color="green">048</FONT>     * configuration.  If you need to add your own, then you can pass in your own<a name="line.48"></a>
<FONT color="green">049</FONT>     * digester rules to use.  It is also namespace aware, by providing a<a name="line.49"></a>
<FONT color="green">050</FONT>     * digesterRuleNamespaceURI.<a name="line.50"></a>
<FONT color="green">051</FONT>     * &lt;/p&gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;p&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;em&gt;Note:&lt;/em&gt; Almost all of the features provided by this class and many<a name="line.53"></a>
<FONT color="green">054</FONT>     * more are also available for the {@link DefaultConfigurationBuilder}<a name="line.54"></a>
<FONT color="green">055</FONT>     * class. {@code DefaultConfigurationBuilder} also has a more robust<a name="line.55"></a>
<FONT color="green">056</FONT>     * merge algorithm for constructing combined configurations. So it is<a name="line.56"></a>
<FONT color="green">057</FONT>     * recommended to use this class instead of {@code ConfigurationFactory}.<a name="line.57"></a>
<FONT color="green">058</FONT>     * &lt;/p&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     *<a name="line.59"></a>
<FONT color="green">060</FONT>     * @author &lt;a href="mailto:epugh@upstate.com"&gt;Eric Pugh&lt;/a&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     * @author &lt;a href="mailto:hps@intermeta.de"&gt;Henning P. Schmiedehausen&lt;/a&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     * @version $Id: ConfigurationFactory.java 1209685 2011-12-02 20:47:44Z oheger $<a name="line.62"></a>
<FONT color="green">063</FONT>     * @deprecated Use {@link DefaultConfigurationBuilder} instead; this class<a name="line.63"></a>
<FONT color="green">064</FONT>     * provides the same features as ConfigurationFactory plus some more; it can<a name="line.64"></a>
<FONT color="green">065</FONT>     * also process the same configuration definition files.<a name="line.65"></a>
<FONT color="green">066</FONT>     */<a name="line.66"></a>
<FONT color="green">067</FONT>    @Deprecated<a name="line.67"></a>
<FONT color="green">068</FONT>    public class ConfigurationFactory<a name="line.68"></a>
<FONT color="green">069</FONT>    {<a name="line.69"></a>
<FONT color="green">070</FONT>        /** Constant for the root element in the info file.*/<a name="line.70"></a>
<FONT color="green">071</FONT>        private static final String SEC_ROOT = "configuration/";<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>        /** Constant for the override section.*/<a name="line.73"></a>
<FONT color="green">074</FONT>        private static final String SEC_OVERRIDE = SEC_ROOT + "override/";<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /** Constant for the additional section.*/<a name="line.76"></a>
<FONT color="green">077</FONT>        private static final String SEC_ADDITIONAL = SEC_ROOT + "additional/";<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /** Constant for the optional attribute.*/<a name="line.79"></a>
<FONT color="green">080</FONT>        private static final String ATTR_OPTIONAL = "optional";<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>        /** Constant for the fileName attribute.*/<a name="line.82"></a>
<FONT color="green">083</FONT>        private static final String ATTR_FILENAME = "fileName";<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>        /** Constant for the load method.*/<a name="line.85"></a>
<FONT color="green">086</FONT>        private static final String METH_LOAD = "load";<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /** Constant for the default base path (points to actual directory).*/<a name="line.88"></a>
<FONT color="green">089</FONT>        private static final String DEF_BASE_PATH = ".";<a name="line.89"></a>
<FONT color="green">090</FONT>    <a name="line.90"></a>
<FONT color="green">091</FONT>        /** static logger */<a name="line.91"></a>
<FONT color="green">092</FONT>        private static Log log = LogFactory.getLog(ConfigurationFactory.class);<a name="line.92"></a>
<FONT color="green">093</FONT>    <a name="line.93"></a>
<FONT color="green">094</FONT>        /** The XML file with the details about the configuration to load */<a name="line.94"></a>
<FONT color="green">095</FONT>        private String configurationFileName;<a name="line.95"></a>
<FONT color="green">096</FONT>    <a name="line.96"></a>
<FONT color="green">097</FONT>        /** The URL to the XML file with the details about the configuration to load. */<a name="line.97"></a>
<FONT color="green">098</FONT>        private URL configurationURL;<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>        /**<a name="line.100"></a>
<FONT color="green">101</FONT>         * The implicit base path for included files. This path is determined by<a name="line.101"></a>
<FONT color="green">102</FONT>         * the configuration to load and used unless no other base path was<a name="line.102"></a>
<FONT color="green">103</FONT>         * explicitly specified.<a name="line.103"></a>
<FONT color="green">104</FONT>         */<a name="line.104"></a>
<FONT color="green">105</FONT>        private String implicitBasePath;<a name="line.105"></a>
<FONT color="green">106</FONT>    <a name="line.106"></a>
<FONT color="green">107</FONT>        /** The basePath to prefix file paths for file based property files. */<a name="line.107"></a>
<FONT color="green">108</FONT>        private String basePath;<a name="line.108"></a>
<FONT color="green">109</FONT>    <a name="line.109"></a>
<FONT color="green">110</FONT>        /** URL for xml digester rules file */<a name="line.110"></a>
<FONT color="green">111</FONT>        private URL digesterRules;<a name="line.111"></a>
<FONT color="green">112</FONT>    <a name="line.112"></a>
<FONT color="green">113</FONT>        /** The digester namespace to parse */<a name="line.113"></a>
<FONT color="green">114</FONT>        private String digesterRuleNamespaceURI;<a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>        /**<a name="line.116"></a>
<FONT color="green">117</FONT>         * Constructor<a name="line.117"></a>
<FONT color="green">118</FONT>         */<a name="line.118"></a>
<FONT color="green">119</FONT>        public ConfigurationFactory()<a name="line.119"></a>
<FONT color="green">120</FONT>        {<a name="line.120"></a>
<FONT color="green">121</FONT>            setBasePath(DEF_BASE_PATH);<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>        /**<a name="line.123"></a>
<FONT color="green">124</FONT>         * Constructor with ConfigurationFile Name passed<a name="line.124"></a>
<FONT color="green">125</FONT>         *<a name="line.125"></a>
<FONT color="green">126</FONT>         * @param configurationFileName The path to the configuration file<a name="line.126"></a>
<FONT color="green">127</FONT>         */<a name="line.127"></a>
<FONT color="green">128</FONT>        public ConfigurationFactory(String configurationFileName)<a name="line.128"></a>
<FONT color="green">129</FONT>        {<a name="line.129"></a>
<FONT color="green">130</FONT>            setConfigurationFileName(configurationFileName);<a name="line.130"></a>
<FONT color="green">131</FONT>        }<a name="line.131"></a>
<FONT color="green">132</FONT>    <a name="line.132"></a>
<FONT color="green">133</FONT>        /**<a name="line.133"></a>
<FONT color="green">134</FONT>         * Return the configuration provided by this factory. It loads the<a name="line.134"></a>
<FONT color="green">135</FONT>         * configuration file which is a XML description of the actual<a name="line.135"></a>
<FONT color="green">136</FONT>         * configurations to load. It can contain various different types of<a name="line.136"></a>
<FONT color="green">137</FONT>         * configuration, e.g. Properties, XML and JNDI.<a name="line.137"></a>
<FONT color="green">138</FONT>         *<a name="line.138"></a>
<FONT color="green">139</FONT>         * @return A Configuration object<a name="line.139"></a>
<FONT color="green">140</FONT>         * @throws ConfigurationException A generic exception that we had trouble during the<a name="line.140"></a>
<FONT color="green">141</FONT>         * loading of the configuration data.<a name="line.141"></a>
<FONT color="green">142</FONT>         */<a name="line.142"></a>
<FONT color="green">143</FONT>        public Configuration getConfiguration() throws ConfigurationException<a name="line.143"></a>
<FONT color="green">144</FONT>        {<a name="line.144"></a>
<FONT color="green">145</FONT>            Digester digester;<a name="line.145"></a>
<FONT color="green">146</FONT>            InputStream input = null;<a name="line.146"></a>
<FONT color="green">147</FONT>            ConfigurationBuilder builder = new ConfigurationBuilder();<a name="line.147"></a>
<FONT color="green">148</FONT>            URL url = getConfigurationURL();<a name="line.148"></a>
<FONT color="green">149</FONT>            try<a name="line.149"></a>
<FONT color="green">150</FONT>            {<a name="line.150"></a>
<FONT color="green">151</FONT>                if (url == null)<a name="line.151"></a>
<FONT color="green">152</FONT>                {<a name="line.152"></a>
<FONT color="green">153</FONT>                    url = ConfigurationUtils.locate(implicitBasePath, getConfigurationFileName());<a name="line.153"></a>
<FONT color="green">154</FONT>                }<a name="line.154"></a>
<FONT color="green">155</FONT>                input = url.openStream();<a name="line.155"></a>
<FONT color="green">156</FONT>            }<a name="line.156"></a>
<FONT color="green">157</FONT>            catch (Exception e)<a name="line.157"></a>
<FONT color="green">158</FONT>            {<a name="line.158"></a>
<FONT color="green">159</FONT>                log.error("Exception caught opening stream to URL", e);<a name="line.159"></a>
<FONT color="green">160</FONT>                throw new ConfigurationException("Exception caught opening stream to URL", e);<a name="line.160"></a>
<FONT color="green">161</FONT>            }<a name="line.161"></a>
<FONT color="green">162</FONT>    <a name="line.162"></a>
<FONT color="green">163</FONT>            if (getDigesterRules() == null)<a name="line.163"></a>
<FONT color="green">164</FONT>            {<a name="line.164"></a>
<FONT color="green">165</FONT>                digester = new Digester();<a name="line.165"></a>
<FONT color="green">166</FONT>                configureNamespace(digester);<a name="line.166"></a>
<FONT color="green">167</FONT>                initDefaultDigesterRules(digester);<a name="line.167"></a>
<FONT color="green">168</FONT>            }<a name="line.168"></a>
<FONT color="green">169</FONT>            else<a name="line.169"></a>
<FONT color="green">170</FONT>            {<a name="line.170"></a>
<FONT color="green">171</FONT>                digester = DigesterLoader.createDigester(getDigesterRules());<a name="line.171"></a>
<FONT color="green">172</FONT>                // This might already be too late. As far as I can see, the namespace<a name="line.172"></a>
<FONT color="green">173</FONT>                // awareness must be configured before the digester rules are loaded.<a name="line.173"></a>
<FONT color="green">174</FONT>                configureNamespace(digester);<a name="line.174"></a>
<FONT color="green">175</FONT>            }<a name="line.175"></a>
<FONT color="green">176</FONT>    <a name="line.176"></a>
<FONT color="green">177</FONT>            // Configure digester to always enable the context class loader<a name="line.177"></a>
<FONT color="green">178</FONT>            digester.setUseContextClassLoader(true);<a name="line.178"></a>
<FONT color="green">179</FONT>            // Add a substitutor to resolve system properties<a name="line.179"></a>
<FONT color="green">180</FONT>            enableDigesterSubstitutor(digester);<a name="line.180"></a>
<FONT color="green">181</FONT>            // Put the composite builder object below all of the other objects.<a name="line.181"></a>
<FONT color="green">182</FONT>            digester.push(builder);<a name="line.182"></a>
<FONT color="green">183</FONT>            // Parse the input stream to configure our mappings<a name="line.183"></a>
<FONT color="green">184</FONT>            try<a name="line.184"></a>
<FONT color="green">185</FONT>            {<a name="line.185"></a>
<FONT color="green">186</FONT>                digester.parse(input);<a name="line.186"></a>
<FONT color="green">187</FONT>                input.close();<a name="line.187"></a>
<FONT color="green">188</FONT>            }<a name="line.188"></a>
<FONT color="green">189</FONT>            catch (SAXException saxe)<a name="line.189"></a>
<FONT color="green">190</FONT>            {<a name="line.190"></a>
<FONT color="green">191</FONT>                log.error("SAX Exception caught", saxe);<a name="line.191"></a>
<FONT color="green">192</FONT>                throw new ConfigurationException("SAX Exception caught", saxe);<a name="line.192"></a>
<FONT color="green">193</FONT>            }<a name="line.193"></a>
<FONT color="green">194</FONT>            catch (IOException ioe)<a name="line.194"></a>
<FONT color="green">195</FONT>            {<a name="line.195"></a>
<FONT color="green">196</FONT>                log.error("IO Exception caught", ioe);<a name="line.196"></a>
<FONT color="green">197</FONT>                throw new ConfigurationException("IO Exception caught", ioe);<a name="line.197"></a>
<FONT color="green">198</FONT>            }<a name="line.198"></a>
<FONT color="green">199</FONT>            return builder.getConfiguration();<a name="line.199"></a>
<FONT color="green">200</FONT>        }<a name="line.200"></a>
<FONT color="green">201</FONT>    <a name="line.201"></a>
<FONT color="green">202</FONT>        /**<a name="line.202"></a>
<FONT color="green">203</FONT>         * Returns the configurationFile.<a name="line.203"></a>
<FONT color="green">204</FONT>         *<a name="line.204"></a>
<FONT color="green">205</FONT>         * @return The name of the configuration file. Can be null.<a name="line.205"></a>
<FONT color="green">206</FONT>         */<a name="line.206"></a>
<FONT color="green">207</FONT>        public String getConfigurationFileName()<a name="line.207"></a>
<FONT color="green">208</FONT>        {<a name="line.208"></a>
<FONT color="green">209</FONT>            return configurationFileName;<a name="line.209"></a>
<FONT color="green">210</FONT>        }<a name="line.210"></a>
<FONT color="green">211</FONT>    <a name="line.211"></a>
<FONT color="green">212</FONT>        /**<a name="line.212"></a>
<FONT color="green">213</FONT>         * Sets the configurationFile.<a name="line.213"></a>
<FONT color="green">214</FONT>         *<a name="line.214"></a>
<FONT color="green">215</FONT>         * @param configurationFileName  The name of the configurationFile to use.<a name="line.215"></a>
<FONT color="green">216</FONT>         */<a name="line.216"></a>
<FONT color="green">217</FONT>        public void setConfigurationFileName(String configurationFileName)<a name="line.217"></a>
<FONT color="green">218</FONT>        {<a name="line.218"></a>
<FONT color="green">219</FONT>            File file = new File(configurationFileName).getAbsoluteFile();<a name="line.219"></a>
<FONT color="green">220</FONT>            this.configurationFileName = file.getName();<a name="line.220"></a>
<FONT color="green">221</FONT>            implicitBasePath = file.getParent();<a name="line.221"></a>
<FONT color="green">222</FONT>        }<a name="line.222"></a>
<FONT color="green">223</FONT>    <a name="line.223"></a>
<FONT color="green">224</FONT>        /**<a name="line.224"></a>
<FONT color="green">225</FONT>         * Returns the URL of the configuration file to be loaded.<a name="line.225"></a>
<FONT color="green">226</FONT>         *<a name="line.226"></a>
<FONT color="green">227</FONT>         * @return the URL of the configuration to load<a name="line.227"></a>
<FONT color="green">228</FONT>         */<a name="line.228"></a>
<FONT color="green">229</FONT>        public URL getConfigurationURL()<a name="line.229"></a>
<FONT color="green">230</FONT>        {<a name="line.230"></a>
<FONT color="green">231</FONT>            return configurationURL;<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>        /**<a name="line.234"></a>
<FONT color="green">235</FONT>         * Sets the URL of the configuration to load. This configuration can be<a name="line.235"></a>
<FONT color="green">236</FONT>         * either specified by a file name or by a URL.<a name="line.236"></a>
<FONT color="green">237</FONT>         *<a name="line.237"></a>
<FONT color="green">238</FONT>         * @param url the URL of the configuration to load<a name="line.238"></a>
<FONT color="green">239</FONT>         */<a name="line.239"></a>
<FONT color="green">240</FONT>        public void setConfigurationURL(URL url)<a name="line.240"></a>
<FONT color="green">241</FONT>        {<a name="line.241"></a>
<FONT color="green">242</FONT>            configurationURL = url;<a name="line.242"></a>
<FONT color="green">243</FONT>            implicitBasePath = url.toString();<a name="line.243"></a>
<FONT color="green">244</FONT>        }<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>        /**<a name="line.246"></a>
<FONT color="green">247</FONT>         * Returns the digesterRules.<a name="line.247"></a>
<FONT color="green">248</FONT>         *<a name="line.248"></a>
<FONT color="green">249</FONT>         * @return URL<a name="line.249"></a>
<FONT color="green">250</FONT>         */<a name="line.250"></a>
<FONT color="green">251</FONT>        public URL getDigesterRules()<a name="line.251"></a>
<FONT color="green">252</FONT>        {<a name="line.252"></a>
<FONT color="green">253</FONT>            return digesterRules;<a name="line.253"></a>
<FONT color="green">254</FONT>        }<a name="line.254"></a>
<FONT color="green">255</FONT>    <a name="line.255"></a>
<FONT color="green">256</FONT>        /**<a name="line.256"></a>
<FONT color="green">257</FONT>         * Sets the digesterRules.<a name="line.257"></a>
<FONT color="green">258</FONT>         *<a name="line.258"></a>
<FONT color="green">259</FONT>         * @param digesterRules The digesterRules to set<a name="line.259"></a>
<FONT color="green">260</FONT>         */<a name="line.260"></a>
<FONT color="green">261</FONT>        public void setDigesterRules(URL digesterRules)<a name="line.261"></a>
<FONT color="green">262</FONT>        {<a name="line.262"></a>
<FONT color="green">263</FONT>            this.digesterRules = digesterRules;<a name="line.263"></a>
<FONT color="green">264</FONT>        }<a name="line.264"></a>
<FONT color="green">265</FONT>    <a name="line.265"></a>
<FONT color="green">266</FONT>        /**<a name="line.266"></a>
<FONT color="green">267</FONT>         * Adds a substitutor to interpolate system properties<a name="line.267"></a>
<FONT color="green">268</FONT>         *<a name="line.268"></a>
<FONT color="green">269</FONT>         * @param digester The digester to which we add the substitutor<a name="line.269"></a>
<FONT color="green">270</FONT>         */<a name="line.270"></a>
<FONT color="green">271</FONT>        protected void enableDigesterSubstitutor(Digester digester)<a name="line.271"></a>
<FONT color="green">272</FONT>        {<a name="line.272"></a>
<FONT color="green">273</FONT>            // This is ugly, but it is safe because the Properties object returned<a name="line.273"></a>
<FONT color="green">274</FONT>            // by System.getProperties() (which is actually a Map&lt;Object, Object&gt;)<a name="line.274"></a>
<FONT color="green">275</FONT>            // contains only String keys.<a name="line.275"></a>
<FONT color="green">276</FONT>            @SuppressWarnings("unchecked")<a name="line.276"></a>
<FONT color="green">277</FONT>            Map&lt;String, Object&gt; systemProperties =<a name="line.277"></a>
<FONT color="green">278</FONT>                    (Map&lt;String, Object&gt;) (Object) System.getProperties();<a name="line.278"></a>
<FONT color="green">279</FONT>            MultiVariableExpander expander = new MultiVariableExpander();<a name="line.279"></a>
<FONT color="green">280</FONT>            expander.addSource("$", systemProperties);<a name="line.280"></a>
<FONT color="green">281</FONT>    <a name="line.281"></a>
<FONT color="green">282</FONT>            // allow expansion in both xml attributes and element text<a name="line.282"></a>
<FONT color="green">283</FONT>            Substitutor substitutor = new VariableSubstitutor(expander);<a name="line.283"></a>
<FONT color="green">284</FONT>            digester.setSubstitutor(substitutor);<a name="line.284"></a>
<FONT color="green">285</FONT>        }<a name="line.285"></a>
<FONT color="green">286</FONT>    <a name="line.286"></a>
<FONT color="green">287</FONT>        /**<a name="line.287"></a>
<FONT color="green">288</FONT>         * Initializes the parsing rules for the default digester<a name="line.288"></a>
<FONT color="green">289</FONT>         *<a name="line.289"></a>
<FONT color="green">290</FONT>         * This allows the Configuration Factory to understand the default types:<a name="line.290"></a>
<FONT color="green">291</FONT>         * Properties, XML and JNDI. Two special sections are introduced:<a name="line.291"></a>
<FONT color="green">292</FONT>         * &lt;code&gt;&amp;lt;override&amp;gt;&lt;/code&gt; and &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt;.<a name="line.292"></a>
<FONT color="green">293</FONT>         *<a name="line.293"></a>
<FONT color="green">294</FONT>         * @param digester The digester to configure<a name="line.294"></a>
<FONT color="green">295</FONT>         */<a name="line.295"></a>
<FONT color="green">296</FONT>        protected void initDefaultDigesterRules(Digester digester)<a name="line.296"></a>
<FONT color="green">297</FONT>        {<a name="line.297"></a>
<FONT color="green">298</FONT>            initDigesterSectionRules(digester, SEC_ROOT, false);<a name="line.298"></a>
<FONT color="green">299</FONT>            initDigesterSectionRules(digester, SEC_OVERRIDE, false);<a name="line.299"></a>
<FONT color="green">300</FONT>            initDigesterSectionRules(digester, SEC_ADDITIONAL, true);<a name="line.300"></a>
<FONT color="green">301</FONT>        }<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>        /**<a name="line.303"></a>
<FONT color="green">304</FONT>         * Sets up digester rules for a specified section of the configuration<a name="line.304"></a>
<FONT color="green">305</FONT>         * info file.<a name="line.305"></a>
<FONT color="green">306</FONT>         *<a name="line.306"></a>
<FONT color="green">307</FONT>         * @param digester the current digester instance<a name="line.307"></a>
<FONT color="green">308</FONT>         * @param matchString specifies the section<a name="line.308"></a>
<FONT color="green">309</FONT>         * @param additional a flag if rules for the additional section are to be<a name="line.309"></a>
<FONT color="green">310</FONT>         * added<a name="line.310"></a>
<FONT color="green">311</FONT>         */<a name="line.311"></a>
<FONT color="green">312</FONT>        protected void initDigesterSectionRules(Digester digester, String matchString, boolean additional)<a name="line.312"></a>
<FONT color="green">313</FONT>        {<a name="line.313"></a>
<FONT color="green">314</FONT>            setupDigesterInstance(<a name="line.314"></a>
<FONT color="green">315</FONT>                digester,<a name="line.315"></a>
<FONT color="green">316</FONT>                matchString + "properties",<a name="line.316"></a>
<FONT color="green">317</FONT>                new PropertiesConfigurationFactory(),<a name="line.317"></a>
<FONT color="green">318</FONT>                METH_LOAD,<a name="line.318"></a>
<FONT color="green">319</FONT>                additional);<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>            setupDigesterInstance(<a name="line.321"></a>
<FONT color="green">322</FONT>                digester,<a name="line.322"></a>
<FONT color="green">323</FONT>                matchString + "plist",<a name="line.323"></a>
<FONT color="green">324</FONT>                new PropertyListConfigurationFactory(),<a name="line.324"></a>
<FONT color="green">325</FONT>                METH_LOAD,<a name="line.325"></a>
<FONT color="green">326</FONT>                additional);<a name="line.326"></a>
<FONT color="green">327</FONT>    <a name="line.327"></a>
<FONT color="green">328</FONT>            setupDigesterInstance(<a name="line.328"></a>
<FONT color="green">329</FONT>                digester,<a name="line.329"></a>
<FONT color="green">330</FONT>                matchString + "xml",<a name="line.330"></a>
<FONT color="green">331</FONT>                new FileConfigurationFactory(XMLConfiguration.class),<a name="line.331"></a>
<FONT color="green">332</FONT>                METH_LOAD,<a name="line.332"></a>
<FONT color="green">333</FONT>                additional);<a name="line.333"></a>
<FONT color="green">334</FONT>    <a name="line.334"></a>
<FONT color="green">335</FONT>            setupDigesterInstance(<a name="line.335"></a>
<FONT color="green">336</FONT>                digester,<a name="line.336"></a>
<FONT color="green">337</FONT>                matchString + "hierarchicalXml",<a name="line.337"></a>
<FONT color="green">338</FONT>                new FileConfigurationFactory(XMLConfiguration.class),<a name="line.338"></a>
<FONT color="green">339</FONT>                METH_LOAD,<a name="line.339"></a>
<FONT color="green">340</FONT>                additional);<a name="line.340"></a>
<FONT color="green">341</FONT>    <a name="line.341"></a>
<FONT color="green">342</FONT>            setupDigesterInstance(<a name="line.342"></a>
<FONT color="green">343</FONT>                digester,<a name="line.343"></a>
<FONT color="green">344</FONT>                matchString + "jndi",<a name="line.344"></a>
<FONT color="green">345</FONT>                new JNDIConfigurationFactory(),<a name="line.345"></a>
<FONT color="green">346</FONT>                null,<a name="line.346"></a>
<FONT color="green">347</FONT>                additional);<a name="line.347"></a>
<FONT color="green">348</FONT>    <a name="line.348"></a>
<FONT color="green">349</FONT>            setupDigesterInstance(<a name="line.349"></a>
<FONT color="green">350</FONT>                digester,<a name="line.350"></a>
<FONT color="green">351</FONT>                matchString + "system",<a name="line.351"></a>
<FONT color="green">352</FONT>                new SystemConfigurationFactory(),<a name="line.352"></a>
<FONT color="green">353</FONT>                null,<a name="line.353"></a>
<FONT color="green">354</FONT>                additional);<a name="line.354"></a>
<FONT color="green">355</FONT>        }<a name="line.355"></a>
<FONT color="green">356</FONT>    <a name="line.356"></a>
<FONT color="green">357</FONT>        /**<a name="line.357"></a>
<FONT color="green">358</FONT>         * Sets up digester rules for a configuration to be loaded.<a name="line.358"></a>
<FONT color="green">359</FONT>         *<a name="line.359"></a>
<FONT color="green">360</FONT>         * @param digester the current digester<a name="line.360"></a>
<FONT color="green">361</FONT>         * @param matchString the pattern to match with this rule<a name="line.361"></a>
<FONT color="green">362</FONT>         * @param factory an ObjectCreationFactory instance to use for creating new<a name="line.362"></a>
<FONT color="green">363</FONT>         * objects<a name="line.363"></a>
<FONT color="green">364</FONT>         * @param method the name of a method to be called or &lt;b&gt;null&lt;/b&gt; for none<a name="line.364"></a>
<FONT color="green">365</FONT>         * @param additional a flag if rules for the additional section are to be<a name="line.365"></a>
<FONT color="green">366</FONT>         * added<a name="line.366"></a>
<FONT color="green">367</FONT>         */<a name="line.367"></a>
<FONT color="green">368</FONT>        protected void setupDigesterInstance(<a name="line.368"></a>
<FONT color="green">369</FONT>                Digester digester,<a name="line.369"></a>
<FONT color="green">370</FONT>                String matchString,<a name="line.370"></a>
<FONT color="green">371</FONT>                ObjectCreationFactory factory,<a name="line.371"></a>
<FONT color="green">372</FONT>                String method,<a name="line.372"></a>
<FONT color="green">373</FONT>                boolean additional)<a name="line.373"></a>
<FONT color="green">374</FONT>        {<a name="line.374"></a>
<FONT color="green">375</FONT>            if (additional)<a name="line.375"></a>
<FONT color="green">376</FONT>            {<a name="line.376"></a>
<FONT color="green">377</FONT>                setupUnionRules(digester, matchString);<a name="line.377"></a>
<FONT color="green">378</FONT>            }<a name="line.378"></a>
<FONT color="green">379</FONT>    <a name="line.379"></a>
<FONT color="green">380</FONT>            digester.addFactoryCreate(matchString, factory);<a name="line.380"></a>
<FONT color="green">381</FONT>            digester.addSetProperties(matchString);<a name="line.381"></a>
<FONT color="green">382</FONT>    <a name="line.382"></a>
<FONT color="green">383</FONT>            if (method != null)<a name="line.383"></a>
<FONT color="green">384</FONT>            {<a name="line.384"></a>
<FONT color="green">385</FONT>                digester.addRule(matchString, new CallOptionalMethodRule(method));<a name="line.385"></a>
<FONT color="green">386</FONT>            }<a name="line.386"></a>
<FONT color="green">387</FONT>    <a name="line.387"></a>
<FONT color="green">388</FONT>            digester.addSetNext(matchString, "addConfiguration", Configuration.class.getName());<a name="line.388"></a>
<FONT color="green">389</FONT>        }<a name="line.389"></a>
<FONT color="green">390</FONT>    <a name="line.390"></a>
<FONT color="green">391</FONT>        /**<a name="line.391"></a>
<FONT color="green">392</FONT>         * Sets up rules for configurations in the additional section.<a name="line.392"></a>
<FONT color="green">393</FONT>         *<a name="line.393"></a>
<FONT color="green">394</FONT>         * @param digester the current digester<a name="line.394"></a>
<FONT color="green">395</FONT>         * @param matchString the pattern to match with this rule<a name="line.395"></a>
<FONT color="green">396</FONT>         */<a name="line.396"></a>
<FONT color="green">397</FONT>        protected void setupUnionRules(Digester digester, String matchString)<a name="line.397"></a>
<FONT color="green">398</FONT>        {<a name="line.398"></a>
<FONT color="green">399</FONT>            digester.addObjectCreate(matchString,<a name="line.399"></a>
<FONT color="green">400</FONT>            AdditionalConfigurationData.class);<a name="line.400"></a>
<FONT color="green">401</FONT>            digester.addSetProperties(matchString);<a name="line.401"></a>
<FONT color="green">402</FONT>            digester.addSetNext(matchString, "addAdditionalConfig",<a name="line.402"></a>
<FONT color="green">403</FONT>            AdditionalConfigurationData.class.getName());<a name="line.403"></a>
<FONT color="green">404</FONT>        }<a name="line.404"></a>
<FONT color="green">405</FONT>    <a name="line.405"></a>
<FONT color="green">406</FONT>        /**<a name="line.406"></a>
<FONT color="green">407</FONT>         * Returns the digesterRuleNamespaceURI.<a name="line.407"></a>
<FONT color="green">408</FONT>         *<a name="line.408"></a>
<FONT color="green">409</FONT>         * @return A String with the digesterRuleNamespaceURI.<a name="line.409"></a>
<FONT color="green">410</FONT>         */<a name="line.410"></a>
<FONT color="green">411</FONT>        public String getDigesterRuleNamespaceURI()<a name="line.411"></a>
<FONT color="green">412</FONT>        {<a name="line.412"></a>
<FONT color="green">413</FONT>            return digesterRuleNamespaceURI;<a name="line.413"></a>
<FONT color="green">414</FONT>        }<a name="line.414"></a>
<FONT color="green">415</FONT>    <a name="line.415"></a>
<FONT color="green">416</FONT>        /**<a name="line.416"></a>
<FONT color="green">417</FONT>         * Sets the digesterRuleNamespaceURI.<a name="line.417"></a>
<FONT color="green">418</FONT>         *<a name="line.418"></a>
<FONT color="green">419</FONT>         * @param digesterRuleNamespaceURI The new digesterRuleNamespaceURI to use<a name="line.419"></a>
<FONT color="green">420</FONT>         */<a name="line.420"></a>
<FONT color="green">421</FONT>        public void setDigesterRuleNamespaceURI(String digesterRuleNamespaceURI)<a name="line.421"></a>
<FONT color="green">422</FONT>        {<a name="line.422"></a>
<FONT color="green">423</FONT>            this.digesterRuleNamespaceURI = digesterRuleNamespaceURI;<a name="line.423"></a>
<FONT color="green">424</FONT>        }<a name="line.424"></a>
<FONT color="green">425</FONT>    <a name="line.425"></a>
<FONT color="green">426</FONT>        /**<a name="line.426"></a>
<FONT color="green">427</FONT>         * Configure the current digester to be namespace aware and to have<a name="line.427"></a>
<FONT color="green">428</FONT>         * a Configuration object to which all of the other configurations<a name="line.428"></a>
<FONT color="green">429</FONT>         * should be added<a name="line.429"></a>
<FONT color="green">430</FONT>         *<a name="line.430"></a>
<FONT color="green">431</FONT>         * @param digester The Digester to configure<a name="line.431"></a>
<FONT color="green">432</FONT>         */<a name="line.432"></a>
<FONT color="green">433</FONT>        private void configureNamespace(Digester digester)<a name="line.433"></a>
<FONT color="green">434</FONT>        {<a name="line.434"></a>
<FONT color="green">435</FONT>            if (getDigesterRuleNamespaceURI() != null)<a name="line.435"></a>
<FONT color="green">436</FONT>            {<a name="line.436"></a>
<FONT color="green">437</FONT>                digester.setNamespaceAware(true);<a name="line.437"></a>
<FONT color="green">438</FONT>                digester.setRuleNamespaceURI(getDigesterRuleNamespaceURI());<a name="line.438"></a>
<FONT color="green">439</FONT>            }<a name="line.439"></a>
<FONT color="green">440</FONT>            else<a name="line.440"></a>
<FONT color="green">441</FONT>            {<a name="line.441"></a>
<FONT color="green">442</FONT>                digester.setNamespaceAware(false);<a name="line.442"></a>
<FONT color="green">443</FONT>            }<a name="line.443"></a>
<FONT color="green">444</FONT>            digester.setValidating(false);<a name="line.444"></a>
<FONT color="green">445</FONT>        }<a name="line.445"></a>
<FONT color="green">446</FONT>    <a name="line.446"></a>
<FONT color="green">447</FONT>        /**<a name="line.447"></a>
<FONT color="green">448</FONT>         * Returns the Base path from which this Configuration Factory operates.<a name="line.448"></a>
<FONT color="green">449</FONT>         * This is never null. If you set the BasePath to null, then a base path<a name="line.449"></a>
<FONT color="green">450</FONT>         * according to the configuration to load is returned.<a name="line.450"></a>
<FONT color="green">451</FONT>         *<a name="line.451"></a>
<FONT color="green">452</FONT>         * @return The base Path of this configuration factory.<a name="line.452"></a>
<FONT color="green">453</FONT>         */<a name="line.453"></a>
<FONT color="green">454</FONT>        public String getBasePath()<a name="line.454"></a>
<FONT color="green">455</FONT>        {<a name="line.455"></a>
<FONT color="green">456</FONT>            String path = StringUtils.isEmpty(basePath)<a name="line.456"></a>
<FONT color="green">457</FONT>                    || DEF_BASE_PATH.equals(basePath) ? implicitBasePath : basePath;<a name="line.457"></a>
<FONT color="green">458</FONT>            return StringUtils.isEmpty(path) ? DEF_BASE_PATH : path;<a name="line.458"></a>
<FONT color="green">459</FONT>        }<a name="line.459"></a>
<FONT color="green">460</FONT>    <a name="line.460"></a>
<FONT color="green">461</FONT>        /**<a name="line.461"></a>
<FONT color="green">462</FONT>         * Sets the basePath for all file references from this Configuration Factory.<a name="line.462"></a>
<FONT color="green">463</FONT>         * Normally a base path need not to be set because it is determined by<a name="line.463"></a>
<FONT color="green">464</FONT>         * the location of the configuration file to load. All relative pathes in<a name="line.464"></a>
<FONT color="green">465</FONT>         * this file are resolved relative to this file. Setting a base path makes<a name="line.465"></a>
<FONT color="green">466</FONT>         * sense if such relative pathes should be otherwise resolved, e.g. if<a name="line.466"></a>
<FONT color="green">467</FONT>         * the configuration file is loaded from the class path and all sub<a name="line.467"></a>
<FONT color="green">468</FONT>         * configurations it refers to are stored in a special config directory.<a name="line.468"></a>
<FONT color="green">469</FONT>         *<a name="line.469"></a>
<FONT color="green">470</FONT>         * @param basePath The new basePath to set.<a name="line.470"></a>
<FONT color="green">471</FONT>         */<a name="line.471"></a>
<FONT color="green">472</FONT>        public void setBasePath(String basePath)<a name="line.472"></a>
<FONT color="green">473</FONT>        {<a name="line.473"></a>
<FONT color="green">474</FONT>            this.basePath = basePath;<a name="line.474"></a>
<FONT color="green">475</FONT>        }<a name="line.475"></a>
<FONT color="green">476</FONT>    <a name="line.476"></a>
<FONT color="green">477</FONT>        /**<a name="line.477"></a>
<FONT color="green">478</FONT>         * A base class for digester factory classes. This base class maintains<a name="line.478"></a>
<FONT color="green">479</FONT>         * a default class for the objects to be created.<a name="line.479"></a>
<FONT color="green">480</FONT>         * There will be sub classes for specific configuration implementations.<a name="line.480"></a>
<FONT color="green">481</FONT>         */<a name="line.481"></a>
<FONT color="green">482</FONT>        public class DigesterConfigurationFactory extends AbstractObjectCreationFactory<a name="line.482"></a>
<FONT color="green">483</FONT>        {<a name="line.483"></a>
<FONT color="green">484</FONT>            /** Actual class to use. */<a name="line.484"></a>
<FONT color="green">485</FONT>            private Class&lt;?&gt; clazz;<a name="line.485"></a>
<FONT color="green">486</FONT>    <a name="line.486"></a>
<FONT color="green">487</FONT>            /**<a name="line.487"></a>
<FONT color="green">488</FONT>             * Creates a new instance of {@code DigesterConfigurationFactory}.<a name="line.488"></a>
<FONT color="green">489</FONT>             *<a name="line.489"></a>
<FONT color="green">490</FONT>             * @param clazz the class which we should instantiate<a name="line.490"></a>
<FONT color="green">491</FONT>             */<a name="line.491"></a>
<FONT color="green">492</FONT>            public DigesterConfigurationFactory(Class&lt;?&gt; clazz)<a name="line.492"></a>
<FONT color="green">493</FONT>            {<a name="line.493"></a>
<FONT color="green">494</FONT>                this.clazz = clazz;<a name="line.494"></a>
<FONT color="green">495</FONT>            }<a name="line.495"></a>
<FONT color="green">496</FONT>    <a name="line.496"></a>
<FONT color="green">497</FONT>            /**<a name="line.497"></a>
<FONT color="green">498</FONT>             * Creates an instance of the specified class.<a name="line.498"></a>
<FONT color="green">499</FONT>             *<a name="line.499"></a>
<FONT color="green">500</FONT>             * @param attribs the attributes (ignored)<a name="line.500"></a>
<FONT color="green">501</FONT>             * @return the new object<a name="line.501"></a>
<FONT color="green">502</FONT>             * @throws Exception if object creation fails<a name="line.502"></a>
<FONT color="green">503</FONT>             */<a name="line.503"></a>
<FONT color="green">504</FONT>            @Override<a name="line.504"></a>
<FONT color="green">505</FONT>            public Object createObject(Attributes attribs) throws Exception<a name="line.505"></a>
<FONT color="green">506</FONT>            {<a name="line.506"></a>
<FONT color="green">507</FONT>                return clazz.newInstance();<a name="line.507"></a>
<FONT color="green">508</FONT>            }<a name="line.508"></a>
<FONT color="green">509</FONT>        }<a name="line.509"></a>
<FONT color="green">510</FONT>    <a name="line.510"></a>
<FONT color="green">511</FONT>        /**<a name="line.511"></a>
<FONT color="green">512</FONT>         * A tiny inner class that allows the Configuration Factory to<a name="line.512"></a>
<FONT color="green">513</FONT>         * let the digester construct FileConfiguration objects<a name="line.513"></a>
<FONT color="green">514</FONT>         * that already have the correct base Path set.<a name="line.514"></a>
<FONT color="green">515</FONT>         *<a name="line.515"></a>
<FONT color="green">516</FONT>         */<a name="line.516"></a>
<FONT color="green">517</FONT>        public class FileConfigurationFactory extends DigesterConfigurationFactory<a name="line.517"></a>
<FONT color="green">518</FONT>        {<a name="line.518"></a>
<FONT color="green">519</FONT>            /**<a name="line.519"></a>
<FONT color="green">520</FONT>             * C'tor<a name="line.520"></a>
<FONT color="green">521</FONT>             *<a name="line.521"></a>
<FONT color="green">522</FONT>             * @param clazz The class which we should instantiate.<a name="line.522"></a>
<FONT color="green">523</FONT>             */<a name="line.523"></a>
<FONT color="green">524</FONT>            public FileConfigurationFactory(Class&lt;?&gt; clazz)<a name="line.524"></a>
<FONT color="green">525</FONT>            {<a name="line.525"></a>
<FONT color="green">526</FONT>                super(clazz);<a name="line.526"></a>
<FONT color="green">527</FONT>            }<a name="line.527"></a>
<FONT color="green">528</FONT>    <a name="line.528"></a>
<FONT color="green">529</FONT>            /**<a name="line.529"></a>
<FONT color="green">530</FONT>             * Gets called by the digester.<a name="line.530"></a>
<FONT color="green">531</FONT>             *<a name="line.531"></a>
<FONT color="green">532</FONT>             * @param attributes the actual attributes<a name="line.532"></a>
<FONT color="green">533</FONT>             * @return the new object<a name="line.533"></a>
<FONT color="green">534</FONT>             * @throws Exception Couldn't instantiate the requested object.<a name="line.534"></a>
<FONT color="green">535</FONT>             */<a name="line.535"></a>
<FONT color="green">536</FONT>            @Override<a name="line.536"></a>
<FONT color="green">537</FONT>            public Object createObject(Attributes attributes) throws Exception<a name="line.537"></a>
<FONT color="green">538</FONT>            {<a name="line.538"></a>
<FONT color="green">539</FONT>                FileConfiguration conf = createConfiguration(attributes);<a name="line.539"></a>
<FONT color="green">540</FONT>                conf.setBasePath(getBasePath());<a name="line.540"></a>
<FONT color="green">541</FONT>                return conf;<a name="line.541"></a>
<FONT color="green">542</FONT>            }<a name="line.542"></a>
<FONT color="green">543</FONT>    <a name="line.543"></a>
<FONT color="green">544</FONT>            /**<a name="line.544"></a>
<FONT color="green">545</FONT>             * Creates the object, a {@code FileConfiguration}.<a name="line.545"></a>
<FONT color="green">546</FONT>             *<a name="line.546"></a>
<FONT color="green">547</FONT>             * @param attributes the actual attributes<a name="line.547"></a>
<FONT color="green">548</FONT>             * @return the file configuration<a name="line.548"></a>
<FONT color="green">549</FONT>             * @throws Exception if the object could not be created<a name="line.549"></a>
<FONT color="green">550</FONT>             */<a name="line.550"></a>
<FONT color="green">551</FONT>            protected FileConfiguration createConfiguration(Attributes attributes) throws Exception<a name="line.551"></a>
<FONT color="green">552</FONT>            {<a name="line.552"></a>
<FONT color="green">553</FONT>                return (FileConfiguration) super.createObject(attributes);<a name="line.553"></a>
<FONT color="green">554</FONT>            }<a name="line.554"></a>
<FONT color="green">555</FONT>        }<a name="line.555"></a>
<FONT color="green">556</FONT>    <a name="line.556"></a>
<FONT color="green">557</FONT>        /**<a name="line.557"></a>
<FONT color="green">558</FONT>         * A factory that returns an XMLPropertiesConfiguration for .xml files<a name="line.558"></a>
<FONT color="green">559</FONT>         * and a PropertiesConfiguration for the others.<a name="line.559"></a>
<FONT color="green">560</FONT>         *<a name="line.560"></a>
<FONT color="green">561</FONT>         * @since 1.2<a name="line.561"></a>
<FONT color="green">562</FONT>         */<a name="line.562"></a>
<FONT color="green">563</FONT>        public class PropertiesConfigurationFactory extends FileConfigurationFactory<a name="line.563"></a>
<FONT color="green">564</FONT>        {<a name="line.564"></a>
<FONT color="green">565</FONT>            /**<a name="line.565"></a>
<FONT color="green">566</FONT>             * Creates a new instance of {@code PropertiesConfigurationFactory}.<a name="line.566"></a>
<FONT color="green">567</FONT>             */<a name="line.567"></a>
<FONT color="green">568</FONT>            public PropertiesConfigurationFactory()<a name="line.568"></a>
<FONT color="green">569</FONT>            {<a name="line.569"></a>
<FONT color="green">570</FONT>                super(null);<a name="line.570"></a>
<FONT color="green">571</FONT>            }<a name="line.571"></a>
<FONT color="green">572</FONT>    <a name="line.572"></a>
<FONT color="green">573</FONT>            /**<a name="line.573"></a>
<FONT color="green">574</FONT>             * Creates the new configuration object. Based on the file name<a name="line.574"></a>
<FONT color="green">575</FONT>             * provided in the attributes either a {@code PropertiesConfiguration}<a name="line.575"></a>
<FONT color="green">576</FONT>             * or a {@code XMLPropertiesConfiguration} object will be<a name="line.576"></a>
<FONT color="green">577</FONT>             * returned.<a name="line.577"></a>
<FONT color="green">578</FONT>             *<a name="line.578"></a>
<FONT color="green">579</FONT>             * @param attributes the attributes<a name="line.579"></a>
<FONT color="green">580</FONT>             * @return the new configuration object<a name="line.580"></a>
<FONT color="green">581</FONT>             * @throws Exception if an error occurs<a name="line.581"></a>
<FONT color="green">582</FONT>             */<a name="line.582"></a>
<FONT color="green">583</FONT>            @Override<a name="line.583"></a>
<FONT color="green">584</FONT>            protected FileConfiguration createConfiguration(Attributes attributes) throws Exception<a name="line.584"></a>
<FONT color="green">585</FONT>            {<a name="line.585"></a>
<FONT color="green">586</FONT>                String filename = attributes.getValue(ATTR_FILENAME);<a name="line.586"></a>
<FONT color="green">587</FONT>    <a name="line.587"></a>
<FONT color="green">588</FONT>                if (filename != null &amp;&amp; filename.toLowerCase().trim().endsWith(".xml"))<a name="line.588"></a>
<FONT color="green">589</FONT>                {<a name="line.589"></a>
<FONT color="green">590</FONT>                    return new XMLPropertiesConfiguration();<a name="line.590"></a>
<FONT color="green">591</FONT>                }<a name="line.591"></a>
<FONT color="green">592</FONT>                else<a name="line.592"></a>
<FONT color="green">593</FONT>                {<a name="line.593"></a>
<FONT color="green">594</FONT>                    return new PropertiesConfiguration();<a name="line.594"></a>
<FONT color="green">595</FONT>                }<a name="line.595"></a>
<FONT color="green">596</FONT>            }<a name="line.596"></a>
<FONT color="green">597</FONT>        }<a name="line.597"></a>
<FONT color="green">598</FONT>    <a name="line.598"></a>
<FONT color="green">599</FONT>        /**<a name="line.599"></a>
<FONT color="green">600</FONT>         * A factory that returns an XMLPropertyListConfiguration for .xml files<a name="line.600"></a>
<FONT color="green">601</FONT>         * and a PropertyListConfiguration for the others.<a name="line.601"></a>
<FONT color="green">602</FONT>         *<a name="line.602"></a>
<FONT color="green">603</FONT>         * @since 1.2<a name="line.603"></a>
<FONT color="green">604</FONT>         */<a name="line.604"></a>
<FONT color="green">605</FONT>        public class PropertyListConfigurationFactory extends FileConfigurationFactory<a name="line.605"></a>
<FONT color="green">606</FONT>        {<a name="line.606"></a>
<FONT color="green">607</FONT>            /**<a name="line.607"></a>
<FONT color="green">608</FONT>             * Creates a new instance of PropertyListConfigurationFactory&lt;/code&gt;.<a name="line.608"></a>
<FONT color="green">609</FONT>             */<a name="line.609"></a>
<FONT color="green">610</FONT>            public PropertyListConfigurationFactory()<a name="line.610"></a>
<FONT color="green">611</FONT>            {<a name="line.611"></a>
<FONT color="green">612</FONT>                super(null);<a name="line.612"></a>
<FONT color="green">613</FONT>            }<a name="line.613"></a>
<FONT color="green">614</FONT>    <a name="line.614"></a>
<FONT color="green">615</FONT>            /**<a name="line.615"></a>
<FONT color="green">616</FONT>             * Creates the new configuration object. Based on the file name<a name="line.616"></a>
<FONT color="green">617</FONT>             * provided in the attributes either a {@code XMLPropertyListConfiguration}<a name="line.617"></a>
<FONT color="green">618</FONT>             * or a {@code PropertyListConfiguration} object will be<a name="line.618"></a>
<FONT color="green">619</FONT>             * returned.<a name="line.619"></a>
<FONT color="green">620</FONT>             *<a name="line.620"></a>
<FONT color="green">621</FONT>             * @param attributes the attributes<a name="line.621"></a>
<FONT color="green">622</FONT>             * @return the new configuration object<a name="line.622"></a>
<FONT color="green">623</FONT>             * @throws Exception if an error occurs<a name="line.623"></a>
<FONT color="green">624</FONT>             */<a name="line.624"></a>
<FONT color="green">625</FONT>            @Override<a name="line.625"></a>
<FONT color="green">626</FONT>            protected FileConfiguration createConfiguration(Attributes attributes) throws Exception<a name="line.626"></a>
<FONT color="green">627</FONT>            {<a name="line.627"></a>
<FONT color="green">628</FONT>                String filename = attributes.getValue(ATTR_FILENAME);<a name="line.628"></a>
<FONT color="green">629</FONT>    <a name="line.629"></a>
<FONT color="green">630</FONT>                if (filename != null &amp;&amp; filename.toLowerCase().trim().endsWith(".xml"))<a name="line.630"></a>
<FONT color="green">631</FONT>                {<a name="line.631"></a>
<FONT color="green">632</FONT>                    return new XMLPropertyListConfiguration();<a name="line.632"></a>
<FONT color="green">633</FONT>                }<a name="line.633"></a>
<FONT color="green">634</FONT>                else<a name="line.634"></a>
<FONT color="green">635</FONT>                {<a name="line.635"></a>
<FONT color="green">636</FONT>                    return new PropertyListConfiguration();<a name="line.636"></a>
<FONT color="green">637</FONT>                }<a name="line.637"></a>
<FONT color="green">638</FONT>            }<a name="line.638"></a>
<FONT color="green">639</FONT>        }<a name="line.639"></a>
<FONT color="green">640</FONT>    <a name="line.640"></a>
<FONT color="green">641</FONT>        /**<a name="line.641"></a>
<FONT color="green">642</FONT>         * A tiny inner class that allows the Configuration Factory to<a name="line.642"></a>
<FONT color="green">643</FONT>         * let the digester construct JNDIConfiguration objects.<a name="line.643"></a>
<FONT color="green">644</FONT>         */<a name="line.644"></a>
<FONT color="green">645</FONT>        private class JNDIConfigurationFactory extends DigesterConfigurationFactory<a name="line.645"></a>
<FONT color="green">646</FONT>        {<a name="line.646"></a>
<FONT color="green">647</FONT>            /**<a name="line.647"></a>
<FONT color="green">648</FONT>             * Creates a new instance of {@code JNDIConfigurationFactory}.<a name="line.648"></a>
<FONT color="green">649</FONT>             */<a name="line.649"></a>
<FONT color="green">650</FONT>            public JNDIConfigurationFactory()<a name="line.650"></a>
<FONT color="green">651</FONT>            {<a name="line.651"></a>
<FONT color="green">652</FONT>                super(JNDIConfiguration.class);<a name="line.652"></a>
<FONT color="green">653</FONT>            }<a name="line.653"></a>
<FONT color="green">654</FONT>        }<a name="line.654"></a>
<FONT color="green">655</FONT>    <a name="line.655"></a>
<FONT color="green">656</FONT>        /**<a name="line.656"></a>
<FONT color="green">657</FONT>         * A tiny inner class that allows the Configuration Factory to<a name="line.657"></a>
<FONT color="green">658</FONT>         * let the digester construct SystemConfiguration objects.<a name="line.658"></a>
<FONT color="green">659</FONT>         */<a name="line.659"></a>
<FONT color="green">660</FONT>        private class SystemConfigurationFactory extends DigesterConfigurationFactory<a name="line.660"></a>
<FONT color="green">661</FONT>        {<a name="line.661"></a>
<FONT color="green">662</FONT>            /**<a name="line.662"></a>
<FONT color="green">663</FONT>             * Creates a new instance of {@code SystemConfigurationFactory}.<a name="line.663"></a>
<FONT color="green">664</FONT>             */<a name="line.664"></a>
<FONT color="green">665</FONT>            public SystemConfigurationFactory()<a name="line.665"></a>
<FONT color="green">666</FONT>            {<a name="line.666"></a>
<FONT color="green">667</FONT>                super(SystemConfiguration.class);<a name="line.667"></a>
<FONT color="green">668</FONT>            }<a name="line.668"></a>
<FONT color="green">669</FONT>        }<a name="line.669"></a>
<FONT color="green">670</FONT>    <a name="line.670"></a>
<FONT color="green">671</FONT>        /**<a name="line.671"></a>
<FONT color="green">672</FONT>         * A simple data class that holds all information about a configuration<a name="line.672"></a>
<FONT color="green">673</FONT>         * from the &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt; section.<a name="line.673"></a>
<FONT color="green">674</FONT>         */<a name="line.674"></a>
<FONT color="green">675</FONT>        public static class AdditionalConfigurationData<a name="line.675"></a>
<FONT color="green">676</FONT>        {<a name="line.676"></a>
<FONT color="green">677</FONT>            /** Stores the configuration object.*/<a name="line.677"></a>
<FONT color="green">678</FONT>            private Configuration configuration;<a name="line.678"></a>
<FONT color="green">679</FONT>    <a name="line.679"></a>
<FONT color="green">680</FONT>            /** Stores the location of this configuration in the global tree.*/<a name="line.680"></a>
<FONT color="green">681</FONT>            private String at;<a name="line.681"></a>
<FONT color="green">682</FONT>    <a name="line.682"></a>
<FONT color="green">683</FONT>            /**<a name="line.683"></a>
<FONT color="green">684</FONT>             * Returns the value of the {@code at} attribute.<a name="line.684"></a>
<FONT color="green">685</FONT>             *<a name="line.685"></a>
<FONT color="green">686</FONT>             * @return the at attribute<a name="line.686"></a>
<FONT color="green">687</FONT>             */<a name="line.687"></a>
<FONT color="green">688</FONT>            public String getAt()<a name="line.688"></a>
<FONT color="green">689</FONT>            {<a name="line.689"></a>
<FONT color="green">690</FONT>                return at;<a name="line.690"></a>
<FONT color="green">691</FONT>            }<a name="line.691"></a>
<FONT color="green">692</FONT>    <a name="line.692"></a>
<FONT color="green">693</FONT>            /**<a name="line.693"></a>
<FONT color="green">694</FONT>             * Sets the value of the {@code at} attribute.<a name="line.694"></a>
<FONT color="green">695</FONT>             *<a name="line.695"></a>
<FONT color="green">696</FONT>             * @param string the attribute value<a name="line.696"></a>
<FONT color="green">697</FONT>             */<a name="line.697"></a>
<FONT color="green">698</FONT>            public void setAt(String string)<a name="line.698"></a>
<FONT color="green">699</FONT>            {<a name="line.699"></a>
<FONT color="green">700</FONT>                at = string;<a name="line.700"></a>
<FONT color="green">701</FONT>            }<a name="line.701"></a>
<FONT color="green">702</FONT>    <a name="line.702"></a>
<FONT color="green">703</FONT>            /**<a name="line.703"></a>
<FONT color="green">704</FONT>             * Returns the configuration object.<a name="line.704"></a>
<FONT color="green">705</FONT>             *<a name="line.705"></a>
<FONT color="green">706</FONT>             * @return the configuration<a name="line.706"></a>
<FONT color="green">707</FONT>             */<a name="line.707"></a>
<FONT color="green">708</FONT>            public Configuration getConfiguration()<a name="line.708"></a>
<FONT color="green">709</FONT>            {<a name="line.709"></a>
<FONT color="green">710</FONT>                return configuration;<a name="line.710"></a>
<FONT color="green">711</FONT>            }<a name="line.711"></a>
<FONT color="green">712</FONT>    <a name="line.712"></a>
<FONT color="green">713</FONT>            /**<a name="line.713"></a>
<FONT color="green">714</FONT>             * Sets the configuration object. Note: Normally this method should be<a name="line.714"></a>
<FONT color="green">715</FONT>             * named {@code setConfiguration()}, but the name<a name="line.715"></a>
<FONT color="green">716</FONT>             * {@code addConfiguration()} is required by some of the digester<a name="line.716"></a>
<FONT color="green">717</FONT>             * rules.<a name="line.717"></a>
<FONT color="green">718</FONT>             *<a name="line.718"></a>
<FONT color="green">719</FONT>             * @param config the configuration to set<a name="line.719"></a>
<FONT color="green">720</FONT>             */<a name="line.720"></a>
<FONT color="green">721</FONT>            public void addConfiguration(Configuration config)<a name="line.721"></a>
<FONT color="green">722</FONT>            {<a name="line.722"></a>
<FONT color="green">723</FONT>                configuration = config;<a name="line.723"></a>
<FONT color="green">724</FONT>            }<a name="line.724"></a>
<FONT color="green">725</FONT>        }<a name="line.725"></a>
<FONT color="green">726</FONT>    <a name="line.726"></a>
<FONT color="green">727</FONT>        /**<a name="line.727"></a>
<FONT color="green">728</FONT>         * An internally used helper class for constructing the composite<a name="line.728"></a>
<FONT color="green">729</FONT>         * configuration object.<a name="line.729"></a>
<FONT color="green">730</FONT>         */<a name="line.730"></a>
<FONT color="green">731</FONT>        public static class ConfigurationBuilder<a name="line.731"></a>
<FONT color="green">732</FONT>        {<a name="line.732"></a>
<FONT color="green">733</FONT>            /** Stores the composite configuration.*/<a name="line.733"></a>
<FONT color="green">734</FONT>            private CompositeConfiguration config;<a name="line.734"></a>
<FONT color="green">735</FONT>    <a name="line.735"></a>
<FONT color="green">736</FONT>            /** Stores a collection with the configs from the additional section.*/<a name="line.736"></a>
<FONT color="green">737</FONT>            private Collection&lt;AdditionalConfigurationData&gt; additionalConfigs;<a name="line.737"></a>
<FONT color="green">738</FONT>    <a name="line.738"></a>
<FONT color="green">739</FONT>            /**<a name="line.739"></a>
<FONT color="green">740</FONT>             * Creates a new instance of {@code ConfigurationBuilder}.<a name="line.740"></a>
<FONT color="green">741</FONT>             */<a name="line.741"></a>
<FONT color="green">742</FONT>            public ConfigurationBuilder()<a name="line.742"></a>
<FONT color="green">743</FONT>            {<a name="line.743"></a>
<FONT color="green">744</FONT>                config = new CompositeConfiguration();<a name="line.744"></a>
<FONT color="green">745</FONT>                additionalConfigs = new LinkedList&lt;AdditionalConfigurationData&gt;();<a name="line.745"></a>
<FONT color="green">746</FONT>            }<a name="line.746"></a>
<FONT color="green">747</FONT>    <a name="line.747"></a>
<FONT color="green">748</FONT>            /**<a name="line.748"></a>
<FONT color="green">749</FONT>             * Adds a new configuration to this object. This method is called by<a name="line.749"></a>
<FONT color="green">750</FONT>             * Digester.<a name="line.750"></a>
<FONT color="green">751</FONT>             *<a name="line.751"></a>
<FONT color="green">752</FONT>             * @param conf the configuration to be added<a name="line.752"></a>
<FONT color="green">753</FONT>             */<a name="line.753"></a>
<FONT color="green">754</FONT>            public void addConfiguration(Configuration conf)<a name="line.754"></a>
<FONT color="green">755</FONT>            {<a name="line.755"></a>
<FONT color="green">756</FONT>                config.addConfiguration(conf);<a name="line.756"></a>
<FONT color="green">757</FONT>            }<a name="line.757"></a>
<FONT color="green">758</FONT>    <a name="line.758"></a>
<FONT color="green">759</FONT>            /**<a name="line.759"></a>
<FONT color="green">760</FONT>             * Adds information about an additional configuration. This method is<a name="line.760"></a>
<FONT color="green">761</FONT>             * called by Digester.<a name="line.761"></a>
<FONT color="green">762</FONT>             *<a name="line.762"></a>
<FONT color="green">763</FONT>             * @param data the data about the additional configuration<a name="line.763"></a>
<FONT color="green">764</FONT>             */<a name="line.764"></a>
<FONT color="green">765</FONT>            public void addAdditionalConfig(AdditionalConfigurationData data)<a name="line.765"></a>
<FONT color="green">766</FONT>            {<a name="line.766"></a>
<FONT color="green">767</FONT>                additionalConfigs.add(data);<a name="line.767"></a>
<FONT color="green">768</FONT>            }<a name="line.768"></a>
<FONT color="green">769</FONT>    <a name="line.769"></a>
<FONT color="green">770</FONT>            /**<a name="line.770"></a>
<FONT color="green">771</FONT>             * Returns the final composite configuration.<a name="line.771"></a>
<FONT color="green">772</FONT>             *<a name="line.772"></a>
<FONT color="green">773</FONT>             * @return the final configuration object<a name="line.773"></a>
<FONT color="green">774</FONT>             */<a name="line.774"></a>
<FONT color="green">775</FONT>            public CompositeConfiguration getConfiguration()<a name="line.775"></a>
<FONT color="green">776</FONT>            {<a name="line.776"></a>
<FONT color="green">777</FONT>                if (!additionalConfigs.isEmpty())<a name="line.777"></a>
<FONT color="green">778</FONT>                {<a name="line.778"></a>
<FONT color="green">779</FONT>                    Configuration unionConfig = createAdditionalConfiguration(additionalConfigs);<a name="line.779"></a>
<FONT color="green">780</FONT>                    if (unionConfig != null)<a name="line.780"></a>
<FONT color="green">781</FONT>                    {<a name="line.781"></a>
<FONT color="green">782</FONT>                        addConfiguration(unionConfig);<a name="line.782"></a>
<FONT color="green">783</FONT>                    }<a name="line.783"></a>
<FONT color="green">784</FONT>                    additionalConfigs.clear();<a name="line.784"></a>
<FONT color="green">785</FONT>                }<a name="line.785"></a>
<FONT color="green">786</FONT>    <a name="line.786"></a>
<FONT color="green">787</FONT>                return config;<a name="line.787"></a>
<FONT color="green">788</FONT>            }<a name="line.788"></a>
<FONT color="green">789</FONT>    <a name="line.789"></a>
<FONT color="green">790</FONT>            /**<a name="line.790"></a>
<FONT color="green">791</FONT>             * Creates a configuration object with the union of all properties<a name="line.791"></a>
<FONT color="green">792</FONT>             * defined in the &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt; section. This<a name="line.792"></a>
<FONT color="green">793</FONT>             * implementation returns a {@code HierarchicalConfiguration}<a name="line.793"></a>
<FONT color="green">794</FONT>             * object.<a name="line.794"></a>
<FONT color="green">795</FONT>             *<a name="line.795"></a>
<FONT color="green">796</FONT>             * @param configs a collection with<a name="line.796"></a>
<FONT color="green">797</FONT>             * {@code AdditionalConfigurationData} objects<a name="line.797"></a>
<FONT color="green">798</FONT>             * @return the union configuration (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.798"></a>
<FONT color="green">799</FONT>             */<a name="line.799"></a>
<FONT color="green">800</FONT>            protected Configuration createAdditionalConfiguration(Collection&lt;AdditionalConfigurationData&gt; configs)<a name="line.800"></a>
<FONT color="green">801</FONT>            {<a name="line.801"></a>
<FONT color="green">802</FONT>                HierarchicalConfiguration result = new HierarchicalConfiguration();<a name="line.802"></a>
<FONT color="green">803</FONT>    <a name="line.803"></a>
<FONT color="green">804</FONT>                for (AdditionalConfigurationData cdata : configs)<a name="line.804"></a>
<FONT color="green">805</FONT>                {<a name="line.805"></a>
<FONT color="green">806</FONT>                    result.addNodes(cdata.getAt(),<a name="line.806"></a>
<FONT color="green">807</FONT>                    createRootNode(cdata).getChildren());<a name="line.807"></a>
<FONT color="green">808</FONT>                }<a name="line.808"></a>
<FONT color="green">809</FONT>    <a name="line.809"></a>
<FONT color="green">810</FONT>                return result.isEmpty() ? null : result;<a name="line.810"></a>
<FONT color="green">811</FONT>            }<a name="line.811"></a>
<FONT color="green">812</FONT>    <a name="line.812"></a>
<FONT color="green">813</FONT>            /**<a name="line.813"></a>
<FONT color="green">814</FONT>             * Creates a configuration root node for the specified configuration.<a name="line.814"></a>
<FONT color="green">815</FONT>             *<a name="line.815"></a>
<FONT color="green">816</FONT>             * @param cdata the configuration data object<a name="line.816"></a>
<FONT color="green">817</FONT>             * @return a root node for this configuration<a name="line.817"></a>
<FONT color="green">818</FONT>             */<a name="line.818"></a>
<FONT color="green">819</FONT>            private HierarchicalConfiguration.Node createRootNode(AdditionalConfigurationData cdata)<a name="line.819"></a>
<FONT color="green">820</FONT>            {<a name="line.820"></a>
<FONT color="green">821</FONT>                if (cdata.getConfiguration() instanceof HierarchicalConfiguration)<a name="line.821"></a>
<FONT color="green">822</FONT>                {<a name="line.822"></a>
<FONT color="green">823</FONT>                    // we can directly use this configuration's root node<a name="line.823"></a>
<FONT color="green">824</FONT>                    return ((HierarchicalConfiguration) cdata.getConfiguration()).getRoot();<a name="line.824"></a>
<FONT color="green">825</FONT>                }<a name="line.825"></a>
<FONT color="green">826</FONT>                else<a name="line.826"></a>
<FONT color="green">827</FONT>                {<a name="line.827"></a>
<FONT color="green">828</FONT>                    // transform configuration to a hierarchical root node<a name="line.828"></a>
<FONT color="green">829</FONT>                    HierarchicalConfiguration hc = new HierarchicalConfiguration();<a name="line.829"></a>
<FONT color="green">830</FONT>                    ConfigurationUtils.copy(cdata.getConfiguration(), hc);<a name="line.830"></a>
<FONT color="green">831</FONT>                    return hc.getRoot();<a name="line.831"></a>
<FONT color="green">832</FONT>                }<a name="line.832"></a>
<FONT color="green">833</FONT>            }<a name="line.833"></a>
<FONT color="green">834</FONT>        }<a name="line.834"></a>
<FONT color="green">835</FONT>    <a name="line.835"></a>
<FONT color="green">836</FONT>        /**<a name="line.836"></a>
<FONT color="green">837</FONT>         * A special implementation of Digester's {@code CallMethodRule} that<a name="line.837"></a>
<FONT color="green">838</FONT>         * is internally used for calling a file configuration's {@code load()}<a name="line.838"></a>
<FONT color="green">839</FONT>         * method. This class differs from its ancestor that it catches all occurring<a name="line.839"></a>
<FONT color="green">840</FONT>         * exceptions when the specified method is called. It then checks whether<a name="line.840"></a>
<FONT color="green">841</FONT>         * for the corresponding configuration the optional attribute is set. If<a name="line.841"></a>
<FONT color="green">842</FONT>         * this is the case, the exception will simply be ignored.<a name="line.842"></a>
<FONT color="green">843</FONT>         *<a name="line.843"></a>
<FONT color="green">844</FONT>         * @since 1.4<a name="line.844"></a>
<FONT color="green">845</FONT>         */<a name="line.845"></a>
<FONT color="green">846</FONT>        private static class CallOptionalMethodRule extends CallMethodRule<a name="line.846"></a>
<FONT color="green">847</FONT>        {<a name="line.847"></a>
<FONT color="green">848</FONT>            /** A flag whether the optional attribute is set for this node. */<a name="line.848"></a>
<FONT color="green">849</FONT>            private boolean optional;<a name="line.849"></a>
<FONT color="green">850</FONT>    <a name="line.850"></a>
<FONT color="green">851</FONT>            /**<a name="line.851"></a>
<FONT color="green">852</FONT>             * Creates a new instance of {@code CallOptionalMethodRule} and<a name="line.852"></a>
<FONT color="green">853</FONT>             * sets the name of the method to invoke.<a name="line.853"></a>
<FONT color="green">854</FONT>             *<a name="line.854"></a>
<FONT color="green">855</FONT>             * @param methodName the name of the method<a name="line.855"></a>
<FONT color="green">856</FONT>             */<a name="line.856"></a>
<FONT color="green">857</FONT>            public CallOptionalMethodRule(String methodName)<a name="line.857"></a>
<FONT color="green">858</FONT>            {<a name="line.858"></a>
<FONT color="green">859</FONT>                super(methodName);<a name="line.859"></a>
<FONT color="green">860</FONT>            }<a name="line.860"></a>
<FONT color="green">861</FONT>    <a name="line.861"></a>
<FONT color="green">862</FONT>            /**<a name="line.862"></a>
<FONT color="green">863</FONT>             * Checks if the optional attribute is set.<a name="line.863"></a>
<FONT color="green">864</FONT>             *<a name="line.864"></a>
<FONT color="green">865</FONT>             * @param attrs the attributes<a name="line.865"></a>
<FONT color="green">866</FONT>             * @throws Exception if an error occurs<a name="line.866"></a>
<FONT color="green">867</FONT>             */<a name="line.867"></a>
<FONT color="green">868</FONT>            @Override<a name="line.868"></a>
<FONT color="green">869</FONT>            public void begin(Attributes attrs) throws Exception<a name="line.869"></a>
<FONT color="green">870</FONT>            {<a name="line.870"></a>
<FONT color="green">871</FONT>                optional = attrs.getValue(ATTR_OPTIONAL) != null<a name="line.871"></a>
<FONT color="green">872</FONT>                        &amp;&amp; PropertyConverter.toBoolean(<a name="line.872"></a>
<FONT color="green">873</FONT>                                attrs.getValue(ATTR_OPTIONAL)).booleanValue();<a name="line.873"></a>
<FONT color="green">874</FONT>                super.begin(attrs);<a name="line.874"></a>
<FONT color="green">875</FONT>            }<a name="line.875"></a>
<FONT color="green">876</FONT>    <a name="line.876"></a>
<FONT color="green">877</FONT>            /**<a name="line.877"></a>
<FONT color="green">878</FONT>             * Calls the method. If the optional attribute was set, occurring<a name="line.878"></a>
<FONT color="green">879</FONT>             * exceptions will be ignored.<a name="line.879"></a>
<FONT color="green">880</FONT>             *<a name="line.880"></a>
<FONT color="green">881</FONT>             * @throws Exception if an error occurs<a name="line.881"></a>
<FONT color="green">882</FONT>             */<a name="line.882"></a>
<FONT color="green">883</FONT>            @Override<a name="line.883"></a>
<FONT color="green">884</FONT>            public void end() throws Exception<a name="line.884"></a>
<FONT color="green">885</FONT>            {<a name="line.885"></a>
<FONT color="green">886</FONT>                try<a name="line.886"></a>
<FONT color="green">887</FONT>                {<a name="line.887"></a>
<FONT color="green">888</FONT>                    super.end();<a name="line.888"></a>
<FONT color="green">889</FONT>                }<a name="line.889"></a>
<FONT color="green">890</FONT>                catch (Exception ex)<a name="line.890"></a>
<FONT color="green">891</FONT>                {<a name="line.891"></a>
<FONT color="green">892</FONT>                    if (optional)<a name="line.892"></a>
<FONT color="green">893</FONT>                    {<a name="line.893"></a>
<FONT color="green">894</FONT>                        log.warn("Could not create optional configuration!", ex);<a name="line.894"></a>
<FONT color="green">895</FONT>                    }<a name="line.895"></a>
<FONT color="green">896</FONT>                    else<a name="line.896"></a>
<FONT color="green">897</FONT>                    {<a name="line.897"></a>
<FONT color="green">898</FONT>                        throw ex;<a name="line.898"></a>
<FONT color="green">899</FONT>                    }<a name="line.899"></a>
<FONT color="green">900</FONT>                }<a name="line.900"></a>
<FONT color="green">901</FONT>            }<a name="line.901"></a>
<FONT color="green">902</FONT>        }<a name="line.902"></a>
<FONT color="green">903</FONT>    }<a name="line.903"></a>




























































</PRE>
</BODY>
</HTML>
